Перейти к основному содержимому

Поиск номенклатуры по артикулу и/или наименованию

Метод позволяет выполнить поиск номенклатуры (досопоставить) по артикулу и/или наименованию.

Для чего может быть использован метод:

  1. Например, необходимо проверить, как будет сопоставлена конкретная позиция из распознанного документа с загруженным справочником.
  2. Например, после распознавания документа, все поля с номенклатурой сопоставлены. Далее пользователь добавил в документ запись с номенклатурой. Для сопоставления новой записи можно использовать данный метод. Т.о. метод позволяет альтернативным способом "досопоставить" введенную пользователем запись.

Пример запроса:

Url: https://extractor.correct.su/api/nomenclatures/search
Headers: Authorization, Content-Type (application/json)
Method: POST
Body:
{
"catalogId": "овощи", // ID справочника номенклатуры. Обязательное поле. Должно быть указано в нижнем регистре.
"article": "42", // Артикул. Если не указан артикул, должно быть заполнено поле "name".
"articleConfidence": 1, // Уверенность распознавания артикула.
// Данное поле надо заполнять тогда, когда в запросе содержится и артикул и наименование.
// Значение поля должно быть от 0 до 1 либо null.
// Если 1 – уверенность составляет 100%, и сопоставление выполняется по артикулу независимо от наименования.
// Если 0 – значение артикула не достоверно.
// Если null или отсутствует, то уверенность распознавания артикула неизвестна.
// В этом случае сопоставление выполняется по наименованию (полю "name").
"name": "томат" // Наименование номенклатуры.
// Если не указано наименование номенклатуры, должно быть заполнено поле "article".
}

Пример ответа:

{
"normalizedFieldValue": "Томат", //Нормализованное значение поля.
"nomenclatureType": "Product", //Тип номенклатуры: товар ("Product"), услуга ("Service") или неизвестно ("Unknown").
"variants": [ //Варианты сопоставления номенклатуры, упорядоченные по убыванию уверенности сопоставления.
{
"id": "string", //Id номенклатуры в справочнике.
"confidence": 0 //Уверенность сопоставления.
}
]
}

Код ответа 200 – возвращает DTO RecognizedNomenclatureInfo с сопоставленной номенклатурой.

Код ответа 400 – данные запроса не прошли валидацию.

Код ответа 401 – пользователь не прошел авторизацию.

Код ответа 500 – возникли исключения.